package com.superkripts.sktools.annotation;

import java.lang.annotation.Documented;
import java.lang.annotation.ElementType;
import java.lang.annotation.Retention;
import java.lang.annotation.RetentionPolicy;
import java.lang.annotation.Target;

/**
 * 指定一个公开的静态方法为Skript的函数
 */
@Documented
@Target(ElementType.METHOD)
@Retention(RetentionPolicy.RUNTIME)
public @interface SkriptFunction {

    /**
     * @return 函数名
     */
    String value();

    /**
     * @return 哪个版本加入的
     */
    String since();

    /**
     * @return 描述
     */
    String[] description();

    /**
     * @return 例子
     */
    String[] examples() default {};

    /**
     * @return 需要这些插件才能够使用此函数
     */
    String[] requiredPlugin() default {};
}
